SftTree/OCX 7.0

SftTree.EditValidate Event

Softel vdm, Inc.

The new contents of the cell being edited are to be validated.

Syntax       

VB.NET

Private Sub object_EditValidate(ByVal sender As Object, ByVal e As EventArgumentType) Handles object.EditValidate

VB

Private Sub object_EditValidate(ByVal Window As OLE_HANDLE, ByVal vData As Variant, ByVal EditIndex As Long, ByVal EditCol As Integer, InputValid As Boolean)

C#.NET

void object_EditValidate(object sender, EventArgumentType e);

VC++

void OnEditValidateobject(OLE_HANDLE Window, const _variant_t& vData, long EditIndex, short EditCol, VARIANT_BOOL* InputValid);

C

HRESULT OnEditValidateobject(OLE_HANDLE Window, VARIANT vData, long EditIndex, short EditCol, VARIANT_BOOL* InputValid);

Delphi

procedure objectEditValidate(Sender: TObject; Window : Cardinal; vData : OleVariant; EditIndex : Integer; EditCol : Smallint; var InputValid : WordBool);

object

A SftTree object.

Window

The window handle of the control being used for cell editing.

vData

Application-specific data provided as vData argument when Cell.Edit was called.

EditIndex

The zero-based index of the item being edited.  The combination of EditIndex and EditCol describes an individual cell.

EditCol

The zero-based column number.  The combination of EditIndex and EditCol describes an individual cell.

InputValid

Return True if the contents are valid, False otherwise.

Comments

The EditValidate event occurs when the new contents of the cell being edited are to be validated.

The EditValidate event occurs when editing of one cell is about to end (the user clicks outside of the current cell being edited, cell navigation is handled or if the EndEdit(True) method is used.  The EditValidate event allows the application to perform input validation. The new cell text currently contained in the control used for cell editing can be inspected and/or modified.  If the text entered or selected is invalid, the InputValid variable can be set to False.  This indicates that the new value cannot be accepted and cell editing is to be resumed.  Setting InputValid to True (default), cell editing is ended.

If cell editing is aborted by the user by pressing the ESCAPE key, the EditValidate event is not generated.

The new cell contents can be saved while handling the EditEnding event.

The tree control properties cannot be modified during this event.  If the tree control is updated in any way, cell editing is terminated. Use the EditEnding event to save the new cell contents.

See Also  SftTree Object | Object Hierarchy


Feedback / comments / error reports for this topic
© 2015 - Softel vdm, Inc. - www.softelvdm.com